/*
 * Copyright (c) 2007, Nubo Technologies
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 *    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *    * Neither the name of the Nubo Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.nubotech.gwt.oss.client;

import java.util.List;

/**
 * 
 * Contains Buckets that are the result of calling listAllBuckets
 * @author jonnakkerud
 */
public class BucketResult {
    private List bucketList;
    protected OnlineStorageServiceError error;
    
    /**
     * Constructor for BucketResult
     * @param bucketList The list of Buckets
     * @param error The error (Can be null)
     */
    public BucketResult(List bucketList, OnlineStorageServiceError error) {
        this.bucketList = bucketList;
        this.error = error;
    }
    
    /**
     * Returns if the result had an error during the call to listAllBuckets
     * @return if the result has an error
     */
    public boolean hasError() {
        return (error != null);
    }
    
    /**
     * Return the error
     * @return The error
     * @see OnlineStorageServiceError
     */
    public OnlineStorageServiceError getError() {
        return error;
    }
    
    /**
     * The number of buckets in this result
     * @return the number of buckets
     */
    public int getRowCount() {
        return bucketList.size();
    }
    
    /**
     * Return a Bucket
     * @param row row number
     * @return Bucket
     */
    public Bucket get(int row) {
        return (Bucket)bucketList.get(row);
    }
       
}
